Issue #

Fixes #505
Fixes #620

Description of changes

Summary

The "release" Package.swift may now be merged back to the main branch following a release, because the special logic in the current Package.swift that is used to adapt the manifest for development and CI use is now provided by the manifest generator script.

Details

The package manifest generation script (scripts/generatePackageSwift.swift) has been improved to allow for generation of a manifest that is free of hard-coded paths and special logic, and that may depend upon smithy-swift or aws-crt-swift referred to by published version, branch or local file path.

The contents of Package.swift are now determined entirely by these inputs:

• The generation script scripts/generatePackageSwift.swift
• The contents of release/ determine which AWS clients are published.
• The settings in versionDependencies.plist determine the version, branch, or path where dependencies are located.
• The env var AWS_SDK_RELEASE_IN_PROGRESS (when set) generates the manifest for a release (dependencies lock to published versions only.)
• Env vars AWS_SDK_SWIFT_CI_DIR, AWS_CRT_SWIFT_CI_DIR, and SMITHY_SWIFT_CI_DIR (when set) override versionDependencies.plist and set local paths to dependencies. (This is for compatibility with the AWS CRT builder script used on our CI tasks.)

No other factors affect the manifest contents, and the manifest may be regenerated any time one of these factors changes. The Package.swift file should no longer be edited by hand, since edits may be overwritten by the script at any time.

(Note that the codegen/Package.swift manifest used for protocol tests is unchanged, and protocol tests still require that the project be installed at ~/Projects/Amplify/SwiftSDK to run on local.)

When developing on the desktop, developers may use the "package edit mode" features of Xcode or Swift Package Manager to develop against local copies of dependencies rather than edit the Package.swift file.

This will allow the release manifest to be merged back into main on each release, eliminating the current Package.swift custom logic which presupposes the local file system location of the SDK and its dependencies. Once a release is merged back in, a SDK consumer will be able to use the SDK from main without additional steps to set it up. (As noted above, this will resolve #505 & #620.)

This PR has been verified to build successfully when built by another project as a CRT builder script downstream dependency (see smithy-lang/smithy-swift#456 which builds this branch as a downstream.)

This PR has also been verified to build a release successfully ( see #667).

Specific changes:

• scripts/generatePackageSwift.swift is improved and derived from chore: Simplify CI, allow merging of releases to main #650 with support for:
  • Published versions, branch names or local file paths specified in versionDependencies.plist
  • Local file paths in env vars AWS_SDK_SWIFT_CI_DIR, AWS_CRT_SWIFT_CI_DIR, and SMITHY_SWIFT_CI_DIR
  • Ignores branch name and local file path settings when building with env var AWS_SDK_RELEASE_IN_PROGRESS set
• Adds a pre-build step to the CRT builder, which dynamically generates Package.swift with file paths pointing to locally installed dependencies when running on CI
• During release, specify that the package manifest should be generated for release (i.e. with exact versions specified) by setting AWS_SDK_RELEASE_IN_PROGRESS

New/existing dependencies impact assessment, if applicable

No new dependencies were added to this change.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.